//=============================================================================
// System  : MatchKit
// File    : LiteralPattern.cs
// Author  : Fabio Bussu  (matchkit@fabiobussu.it)
// Updated : 04/16/2013
// Note    : Copyright 2013, Fabio Bussu, All rights reserved
//
// This code is published under the Microsoft Public License (Ms-PL). A copy
// of the license should be distributed with the code.  It can also be found
// at the project website: http://matchkit.codeplex.com. This notice, the
// author's name, and all copyright notices must remain intact in all
// applications, documentation, and source files.
//
// Version     Date     Who  Comments
// ============================================================================
// 1.0.0.0  04/16/2013   FB  First draft
//=============================================================================
using System;
using System.Runtime.Serialization;

namespace MatchKit.Patterns
{
	/// <summary>
	/// Provides the logic to match a string enclosed between two characters.
	/// </summary>
	/// <threadsafety static="true" instance="false" />
	/// <serialization binary="true" contract="true" />
	/// <conceptualLink target="cb785773-b793-4cc8-acc4-6688cdb226b6" />
	/// <conceptualLink target="0a06b2a9-5f58-409a-ba62-639cfd77bca7" />
	#if DC
	[DataContract]
	#endif
	#if SZ
	[Serializable]
	#endif
	public sealed class LiteralPattern : BasePattern
	{
		/// <summary>
		/// Initializes a new instance of the <see cref="T:MatchKit.Patterns.LiteralPattern"/> class. 
		/// </summary>
		public LiteralPattern()
		{
		}

		/// <summary>
		/// Initializes a new instance of the <see cref="T:MatchKit.Patterns.LiteralPattern"/> class. 
		/// </summary>
		/// <param name="enclosingCharacter">Character to match before and after an enclosed string. See <see cref="P:LiteralPattern.EnclosingCharacter"/>.</param>
		public LiteralPattern(char enclosingCharacter)
		{
			EnclosingCharacter = enclosingCharacter;
		}

		private char _enclosingCharacter = '\"';
		/// <summary>
		/// Gets or sets the character to match to identify the enclosing. 
		/// If the character is redoubled a single character will be kept as enclosed value. 
		/// Default is <b>"</b>.
		/// </summary>
		/// <serialization member="true" />
		#if DC
		[DataMember]
		#endif
		public char EnclosingCharacter
		{
			get { return _enclosingCharacter; }
			set { _enclosingCharacter = value; }
		}

		/// <inheritdoc />
		protected override Match OnMatch(MatchContext context)
		{
			if (!context.Is(_enclosingCharacter))
				return Error(context);

			var literal = string.Empty;

			do
			{
				context.NextCharacter();	// skip EnclosingChar
				var capture = new Capture(context, true);
				context.NextTo(ch => ch != _enclosingCharacter);
				// se anche il prossimo e' un EnclosingChar
				if (context.Peek(_enclosingCharacter))
				{
					context.NextCharacter();
					literal += capture.ToString();
				}
				else
				{
					literal += capture.ToString();
					break;
				}
			}
			while (true);

			context.NextCharacter();	// skip EnclosingChar

			return Success(context, literal);
		}

		/// <inheritdoc />
		public override string HelpString
		{
			get { return "Literal enclosed by (" + _enclosingCharacter + ")"; }
		}
	}
}
